analytics_dashboard_home_overview

Home > Overview payment-recovery card (recovered / retrying / written-off + trailing baseline)

Returns dunning-effectiveness numbers for the current month: the total failed-payment amount, its recovered / retrying / written-off breakdown, the won-back percentage, and a trailing- 6-month baseline. Recovery is computed from BillingEvent transitions (failed later followed by succeeded on the same subscription) — subscriptions.last_failed_at clears to NULL on success, so subscription columns can’t be trusted.

GET

api

v202604

analytics

dashboard

payment_recovery

Home > Overview payment-recovery card (recovered / retrying / written-off + trailing baseline)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "failed_amount": "180.25",
  "failed_count": 1,
  "recovered_amount": "180.25",
  "recovered_count": 1,
  "retrying_amount": "180.25",
  "retrying_count": 1,
  "written_off_amount": "180.25",
  "written_off_count": 1,
  "won_back_pct": "42.5",
  "baseline_won_back_pct": "42.5",
  "top_retrying_reasons": [
    "<string>"
  ],
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Requires a company-admin token whose role holds reports.view. Additionally, the caller's company must have ANALYTICS_DASHBOARD enabled — otherwise every endpoint returns 404.

Query Parameters

country

string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

Response

Payment-recovery card payload

Dunning effectiveness for the current calendar month. Amounts are attributed by the failing subscription's current price, one entry per subscription per bucket. Recovery is derived from BillingEvent transitions because subscriptions.last_failed_at clears to NULL on success.

failed_amount

string

required

Decimal amount, expressed as a string to preserve arbitrary precision across the wire. Parsed to Number on the client and formatted with Intl.NumberFormat. Once the in-flight money-cents-migration lands, this will switch to a { amount_cents: integer, currency: string } object.

Example:

"180.25"

failed_count

integer

required

Required range: x >= 0

recovered_amount

string

required

Example:

"180.25"

recovered_count

integer

required

Required range: x >= 0

retrying_amount

string

required

Example:

"180.25"

retrying_count

integer

required

Required range: x >= 0

written_off_amount

string

required

Example:

"180.25"

written_off_count

integer

required

Required range: x >= 0

won_back_pct

string

required

A percentage share, expressed as a decimal string rounded to one decimal place. "100.0" when a single bucket accounts for the full total; "0.0" when the divisor was zero.

Example:

"42.5"

baseline_won_back_pct

string

required

A percentage share, expressed as a decimal string rounded to one decimal place. "100.0" when a single bucket accounts for the full total; "0.0" when the divisor was zero.

Example:

"42.5"

top_retrying_reasons

string[]

required

Up to two human-readable category labels describing the dominant failure reasons among the retrying subscriptions (e.g. "insufficient funds", "expired cards"). Empty when nothing is retrying or no reasons categorised.

Maximum array length: 2

currency

string

required

ISO 4217 three-letter code (uppercase).

Required string length: 3

Example:

"USD"

meta

object

Show child attributes

Home > Overview payment-recovery card (recovered / retrying / written-off + trailing baseline)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/payment_recovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "failed_amount": "180.25",
  "failed_count": 1,
  "recovered_amount": "180.25",
  "recovered_count": 1,
  "retrying_amount": "180.25",
  "retrying_count": 1,
  "written_off_amount": "180.25",
  "written_off_count": 1,
  "won_back_pct": "42.5",
  "baseline_won_back_pct": "42.5",
  "top_retrying_reasons": [
    "<string>"
  ],
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Home > Overview payment-recovery card (recovered / retrying / written-off + trailing baseline)

Authorizations

Query Parameters

Response